安装时对接已有监控系统

最后于 2024年12月20日 更新

APO 向导式可观测性平台为用户提供了一站式的可观测性数据展示和分析能力。APO不仅能够展示通过APO采集器采集到的数据，也能接入已有监控数据，无需对现有监控系统进行大规模改动即可使用现代化的可观测性平台。

信息

要对接已有监控系统，需要满足对接要求，并且可能会缺失部分 APO 功能，具体要求与限制请参考文档数据接入能力详细说明。

APO 支持接入的监控数据按照类型可以分为以下几类：

链路追踪：如果您已经使用链路追踪探针，无需重复安装 APO 的 Tracing 注入工具
指标：如果您已经使用类 Prometheus 采集存储指标，无需重复安装 Metrics 采集工具，同时可以使用已有类 Prometheus 系统作为 APO 的指标存储
日志：如果您已经采集日志并存储到 ClickHouse 中，可以使用该 ClickHouse 作为 APO 的存储，同时在 APO 中查看全量日志

本文档给出常见场景下将已有监控数据接入 APO 平台的安装方案，更多场景请参考数据接入能力详细说明进行配置。

要对接已有监控系统，需要在安装 APO 时调整安装配置文件以适配对应环境。整体安装流程与安装 APO 完整版相同，请在“配置APO组件”阶段按照下文的说明进行配置。

APO Server 安装配置说明

在使用 Helm 安装 APO Server 时，需要使用配置文件进行安装，调整其中的配置项，能够实现对接已有指标存储系统和已有日志。

信息

下文仅给出配置文件中需要调整的部分，完整配置项内容请参考完整配置文档。

对接已有链路追踪数据

如您想在 APO 平台上对接已有链路追踪数据，请在安装 APO Server 时配置apoApmAdapter部分。如下所示调整配置文件：

global:
  apo-one-agent:
    enabled: false

  apo-collector:
    apoApmAdapter:
      config:
        adapter:
          # 暴露HTTP端口号.
          http_port: 8079
          # 设置HTTP请求超时时间，超时则直接返回.
          timeout: 10
          # APM系统对接.
          trace_api:
            # 开启apm对接列表
            apm_list: [skywalking, jaeger, elastic]
            # Skywalking配置
            skywalking:
              address: ""
              user: ""
              password: ""
            # Jaeger配置
            jaeger:
              address: apo-jaeger-collector-svc:16686/jaeger
            # Tingyun3相关配置
            nbs3:
              address: ""
              user: ""
              password: ""
            # Arms相关配置
            arms:
              address: "arms.cn-hangzhou.aliyuncs.com"
              access_key: ""
              access_secret: ""
            elastic:
              # 可以添加协议前缀'https://'或'http://'，默认http
              address: ""
              user: ""
              password: ""
            # Pinpoint配置
            pinpoint:
              address: ""

请根据实际情况将使用的追踪系统类型添加到apm_list中，并配置对应追踪系统的地址、用户名、密码等参数。随后使用该配置文件安装 APO Server 即可对接已有链路追踪数据。

注意使用该模式安装 APO Server 后，需要在安装 APO OneAgent 时采用 trace-sidecar 模式，详见 APO OneAgent 安装配置说明。

信息

该安装方案的限制与效果请查看文档链路追踪对接方案一

对接已有指标数据

如您想在 APO 平台上查看已有指标，请在安装 APO Server 时使用已有类 Prometheus 作为指标存储系统。如下所示调整配置文件：

# victoriaMetricsUrl: 托管 VictoriaMetrics 访问地址
# 如果您的 VictoriaMetrics 带有基础认证，则将用户名密码带入 URL
# 如果您的密码带有特殊字符需要转换为 URL 编码字符
# 以 用户名apo，密码Apo@123456 为例
# global:
#   victoriaMetricsUrl: "http://apo:Apo%40123456@apo-victoria-metrics-single-server-svc:8428"
global:
  victoriaMetricsUrl: "http://apo-victoria-metrics-single-server-svc:8428" # FIXME

# 配置 APO-server 不创建 VictoriaMetrics 实例
victoria-metrics-single:
  enabled: false

对接存储到 ClickHouse 的日志数据

如您想到 APO 平台上查看已有日志，请在安装 APO Server 时使用存储有日志的 ClickHouse。如下所示调整配置文件：

# clickhouseUrl: 托管 Clickhouse 访问地址
# clickhouseHttpUrl: 托管 Clickhouse HTTP访问地址
# clickhouseRootUsername: 托管 Clickhouse 访问用户名，需要双引号
# clickhouseRootPassword: 托管 Clickhouse 访问密码，需要双引号
# clickhosueDatabase: 托管 Clickhouse 访问数据库名，非必要不用修改，需要双引号
global:
  clickhouseUrl: "apo-clickhouse-svc:9000" # FIXME
  clickhouseHttpUrl: "apo-clickhouse-svc:8123" # FIXME
  clickhouseRootUsername: "apo-user" # FIXME
  clickhouseRootPassword: "Apo@123456" # FIXME
  clickhosueDatabase: "apo"

## 配置 APO 组件
# APO-server 配置
# 配置 APO-server 不创建 Clickhouse 实例
altinity-clickhouse-operator:
  enabled: false

APO OneAgent 安装配置说明

在使用 Helm 安装 APO OneAgent 时，需要使用下面的配置文件进行安装：

global:
  agentCollectorMode:
    # Trace 采集模式
    # - trace 全量采集，自动注入Trace采集探针
    # - trace-collcetor 使用 collector 接受外部探针Trace数据
    # - trace-sidecar 不接受外部Trace数据，直接从外部API中读取数据，使用本模式需要配置外部API数据源
    - trace
    - metrics
    - log

通过组合调整agentCollectorMode中的选项，能够满足各类接入数据的使用场景。

链路追踪相关

请填充

包含trace：安装 Tracing 探针自动注入工具，适用于没有使用过 Tracing 探针的场景
包含trace-sidecar：适用于已经使用 Tracing 探针，不期望改造 Traces 数据发送地址的场景，需要在安装 APO Server 时配置 Traces 数据地址。
包含trace-collector：适用于已经使用 Tracing 探针，可以改造 Traces 数据发送地址的场景，需要修改已有探针的数据发送地址，详情见链路追踪对接方案二
不包含trace、trace-sidecar和trace-collector：适用于无需获取 Traces 和应用请求指标的场景

指标相关

包含 metrics：安装 Metrics 采集工具，适用于需要采集环境基础监控指标的场景
- 如果不包含该选项，不会采集指标；如您想在 APO 平台上查看已有指标，请在安装 APO Server 时使用已有类 Prometheus 作为指标存储系统。

日志相关

包含 log：安装日志采集工具，适用于需要采集故障现场日志或全量日志的场景
- 建议始终采集故障现场日志，该数据量较少且资源消耗较小
- 如果不包含该选项，不会采集日志数据；如您想到 APO 平台上查看已有日志，请在安装 APO Server 时使用存储有日志的 ClickHouse。

APO Server 安装配置说明​

对接已有链路追踪数据​

对接已有指标数据​

对接存储到 ClickHouse 的日志数据​

APO OneAgent 安装配置说明​

链路追踪相关​

指标相关​

日志相关​